setup swagger spec and raml2swagger script #71
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
February 13, 2017 17:29
…dator. some concepts we use in RAML don't translate over, at least not with this conversion tool. nothing significant though
…y a 'baseUri' to use for mocks/validation, strip out the domain name from what we've now specified in the raml baseUri field
|
Nice. |
|
I could move the swagger file to a /swagger directory. That would also let me drop a separate readme in there explaining our position on Swagger vs RAML. Will do tomorrow.
On Feb 14, 2017, at 12:40 AM, Nick Pearce <notifications@github.com<mailto:notifications@github.com>> wrote:
Nice.
Small thought: the project root is going to start getting cluttered with yaml/docker/scripts but not sure how to handle just yet.
-
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub<#71 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AB1xQicdyOO0gUIwl6pkz9Ip-2KI1ERnks5rcT5DgaJpZM4L_6Nm>.
|
|
@npearce-kpmg please take another look |
crayl-kpmg
approved these changes
Feb 14, 2017
DEVGUIDE.md
Outdated
| npm run raml2swagger | ||
| ``` | ||
|
|
||
| This task will process the /raml/api.v1.yaml and convert it to /swagger/api.v1.yaml. |
There was a problem hiding this comment.
I think this should read: /raml/api.v1.raml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tweaks to RAML and osprey config to enable clean conversion to swagger
added raml2swagger script so we can update the swagger spec whenever RAML gets changed (this is something we'll have to remember to do)
resolves #10